Device Communication: Flow-Cal Request Missing Data
Note: This command is provided as an optional feature, in REPOSITORY mode only, and via scheduling or scripting only. For this command to function, certain requirements must be met.
If installed, Flow-Cal Request Missing Data (FCREQMISS via script) is the command that triggers the FMS to scan a specified Flow-Cal database (via the Flow-Cal SCADA Request interface) in order to retrieve and process Flow-Cal requests for missing device data. The command is executed for the system, not for specific Nodes.
Note: This command is available only via the Master Scheduling Service in CygNet Explorer or via scripting (not through the FMS Explorer user interface).
You must have proper security authorization to execute this command. See FMS Security (and CMDDEV security event) for information about configuring security access for FMS commands.
See Scheduling FMS Command Tasks in the MSS for more information about scheduling commands.
See CxFms for more information about scripting commands.
Command Requirements
To enable the command to process Flow-Cal missing data requests, the following elements must be present.
- Flow-Cal Database connection - A connection must be established between the FMS and the service hosting the Flow-Cal database, and database connectivity must be available to the FMS. The database connection is defined in the FMS configuration file (CygNet\Services\FMS\fms.cfg) via a set of FCDB Database Info keywords. See FMS Configuration File Keywords for more information about configuring the Database Info Keywords to support the Flow-Cal database connection.
Note: Refer to Flow-Cal documentation and/or contact your Flow-Cal representative for the most current information about specific Flow-Cal configuration details.
Flow-Cal Request Missing Data Process
The Flow-Cal missing data request is processed as follows.
- When the missing data request is sent, the FMS will attempt to connect to the specified Flow-Cal database, as configured in the FMS configuration file (CygNet\Services\FMS\fms.cfg).
- If the FMS can successfully connect to the Flow-Cal database, it will scan the database for missing data requests. If there are requests for missing data records present in the Flow-Cal database, then FMS will retrieve and process the missing data request.
- If the FMS cannot successfully connect to the Flow-Cal database, then the failure to connect will be logged as an error by the FMS.
Note: Missing data records processed in FMS as a result of this command are then available to the Flow-Cal database via subsequent Export: Flow-Cal Transaction Queue commands.
See Viewing Command Logs for information about viewing historical logs for this command.
Configuring a Flow-Cal Request Missing Data Command
The Flow-Cal Request Missing Data command is run against the FMS service, rather than against specific Nodes, and can only be executed via the Master Scheduling Service (MSS) in CygNet Explorer or via scripting.
Command Definition Properties
The following command definition properties apply to Flow-Cal Request Missing Data commands, when scheduling, creating, or editing commands via CygNet Explorer.
| Property | Description |
|---|---|
|
FMS service |
Select a Site.Service for the command from the available FMS service list in the drop-down menu. |
|
Command |
Select the desired Command name from the drop-down menu. See FMS Commands for more information about available command types. |
|
Priority |
Select a processing queue Priority for the command from the drop-down menu. Options from least to greatest priority are as follows.
Default value is Low level processing queue priority. |
|
Logging |
Select a Logging level for the command results from the drop-down menu. Options are as follows.
Default value is Low level logging. |
Command Parameters
The following command parameters apply to Flow-Cal Request Missing Data commands, when scheduling, creating, or editing commands via CygNet Explorer or scripting.
| Parameter | Description | Type | Usage Notes |
|---|---|---|---|
|
ImpMxRun |
Max runtime (minutes) |
Integer |
Double-click to access the Enter Max Run Time (minutes) dialog box. Enter the number of minutes to allow the command to run before it will timeout. Note: Entering a value of 0 causes the command to run indefinitely. This parameter is required. |
